Skip to content

Add pvlib.spa.transit_sunrise_sunset to documentation - #2873

Open
AdamRJensen wants to merge 2 commits into
pvlib:mainfrom
AdamRJensen:add_transit_sunrise_sunset_to_docs
Open

AdamRJensen wants to merge 2 commits into
pvlib:mainfrom
AdamRJensen:add_transit_sunrise_sunset_to_docs

Conversation

@AdamRJensen

Copy link
Copy Markdown
Member
  • Closes transit_sunrise_sunset: seems as a public function, not in public docs? #2255
  • I am familiar with the contributing guidelines
  • I attest that all AI-generated material has been vetted for accuracy and is in compliance with the pvlib license
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

Add transit_sunrise_sunset function to documentation. See #2255.

@AdamRJensen AdamRJensen added this to the v0.16.2 milestone Sep 29, 2026
Comment thread pvlib/spa.py
"""
Calculate the sun transit, sunrise, and sunset
for a set of dates at a given location.
for a set of dates at a given location using the NREL SPA [1]_.

@RDaxini RDaxini Oct 5, 2026 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion contingent on #2873 (comment)

Suggested change
for a set of dates at a given location using the NREL SPA [1]_.
for a set of dates at a given location using the NREL SPA [1]_, [2]_.

Comment thread pvlib/spa.py
.. [1] I. Reda and A. Andreas, Solar position algorithm for solar
radiation applications. Solar Energy, vol. 76, no. 5, pp. 577-589,
2004. :doi:`10.1016/j.solener.2003.12.003`
"""

@RDaxini RDaxini Oct 5, 2026 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we cite the corrigendum as well? Open question from me, not a direct suggestion. My first thought is that it might be helpful to users for completeness at no cost.
Note: we do cite both in spa.solar_position

Suggested change
"""
References
----------
.. [1] I. Reda and A. Andreas, Solar position algorithm for solar
radiation applications. Solar Energy, vol. 76, no. 5, pp. 577-589,
2004. :doi:`10.1016/j.solener.2003.12.003`
.. [2] I. Reda, and A. Andreas. "Corrigendum to “Solar position
algorithm for solar radiation applications." [Solar Energy 76
(2004) 577–589] Solar Energy, vol. 81, no. 6, pp. 838, 2007.
:doi:`10.1016/j.solener.2007.01.003`
"""

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

transit_sunrise_sunset: seems as a public function, not in public docs?

4 participants